7.1 新增应用
Path: /api/v1/resource/createResource
Method: POST
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
创建web应用
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
accessModel | string | 必须 | 访问模式 | 填写WEB即可 | |
subModel | string | 必须 | 子访问模式 | 填写WEB即可 | |
description | string | 非必须 | 描述 | ||
groupId | string | 非必须 | 所属应用分类ID | 可通过应用分类查询接口获取ID | |
groupName | string | 非必须 | 所属应用分类名 | 该参数与groupId至少存在一个。若均存在,以groupId优先 | |
status | number | 必须 | 启用状态 | 0禁用,1启用 | |
nodeGroupId | string | 非必须 | 应用所属节点区域的id | ||
nodeGroupName | string | 非必须 | 应用所属节点区域的名称 | 该参数与nodeGroupId至少存在一个。若均存在,以nodeGroupId优先 | |
iconId | string | 必须 | 预置的图标ID,"1"~"31"可供选择 | 自定义图标设置建议在控制台中配置 | |
allowApply | number | 必须 | 是否允许用户自助申请此应用 | 0不允许,1允许 | |
applyForInfo | object | 必须 | 用户申请信息 | ||
├─ content | string | 必须 | 告警内容 | 例如:"您当前没有该应用的访问权限,请向管理员申请!" | |
├─ accessReason | string[] | 必须 | 申请理由,最少2条,最多5条 | 例如:["我因为岗位职责原因需要访问该应用", "我因为个人特殊原因需要访问该应用"] | |
appAddress | string | 必须 | 后端应用服务器地址 | 示例: https://1.2.3.1 | |
aliasAppAddress | string | 非必须 | 后端应用服务器地址别名,英文逗号分隔 | 示例: https://1.1.1.2,https://1.1.1.3,https://1.1.1.4 | |
accessAddress | string | 必须 | 前端应用访问地址 | 示例: https://testweb.com | |
trustedCertId | string | 必须 | 授信证书ID,默认内置web应用证书ID为"default" | ||
ext | object | 必须 | 扩展字段 | ||
├─ hide | number | 必须 | 是否在用户应用中心隐藏 | 0不隐藏,1隐藏 | |
├─ dependSites | object | 必须 | 依赖站点配置,依赖站点功能需要配置泛域名的授信证书才能开启 | ||
├─├─ enable | number | 必须 | 是否启用依赖站点 | 0禁用,1启用 | |
├─├─ panDomain | string | 非必须 | 泛域名 | ||
├─├─ siteList | object[] | 非必须 | 依赖站点 | ||
├─├─├─ appAddress | string | 非必须 | 后端地址 | ||
├─├─├─ accessAddress | string | 非必须 | 前端访问地址 | ||
├─ pathStatus | number | 非必须 | url路径规则模式 | 0黑名单模式,1白名单模式 | |
├─ paths | string[] | 非必须 | url路径规则 | 例如: ["/asdsad", "/asdasdwe"] | |
├─ security | object | 非必须 | 应用安全配置 | ||
├─├─ watermark | object | 非必须 | 水印配置 | ||
├─├─├─ enable | number | 非必须 | 是否启用水印 | 0禁用,1启用 | |
├─ openModel | object | 非必须 | 打开方式 | ||
├─├─ model | string | 非必须 | default-browser | 方式,有如下几种值:default-browser、custom-browser | |
├─├─ programName | string | 非必须 | 程序名称,如果model填写的custom-browser是,则此项需要填写,有如下几种值:Google Chrome(谷歌浏览器)、Internet Explorer(IE浏览器)、360安全浏览器、360极速浏览器、Firefox(火狐浏览器)、Microsoft Edge、QQ浏览器、搜狗浏览器 | ||
├─├─ processName | string | 非必须 | 进程名,如果填写了programName,则需要填写此项,每种浏览器对应的进程名为: Google Chrome(谷歌浏览器):chrome.exe Internet Explorer(IE浏览器):iexplore.exe 360安全浏览器:360se.exe 360极速浏览器:360chrome.exe Firefox(火狐浏览器):firefox.exe Microsoft Edge:msedge.exe QQ浏览器:QQBrowser.exe 搜狗浏览器:SogouExplorer.exe |
||
├─├─ issuerName | array | 非必须 | 签名者名称,如果填写了programName,则需要填写此项,每种浏览器对应的签名者名称为: Google Chrome(谷歌浏览器):Google LLC Internet Explorer(IE浏览器):Microsoft Corporation 360安全浏览器:Beijing Qihu Technology Co., Ltd. 360极速浏览器:Beijing Qihu Technology Co., Ltd. Firefox(火狐浏览器):Mozilla Corporation Microsoft Edge:Microsoft Corporation QQ浏览器:Tencent Technology(Shenzhen) Company Limited 搜狗浏览器:Beijing Sogou Technology Development Co., Ltd. |
||
├─├─ originalFilename | string | 非必须 | 原始文件名,如果填写了programName,则需要填写此项,每种浏览器对应的原始文件名为: Google Chrome(谷歌浏览器):chrome.exe Internet Explorer(IE浏览器):IEXPLORE.EXE 360安全浏览器:360se.exe 360极速浏览器:360chrome.exe Firefox(火狐浏览器):firefox.exe Microsoft Edge:msedge.exe QQ浏览器:QQBrowser.exe 搜狗浏览器:(该浏览器不存在原始文件名) |
||
├─├─ useDefaultBrowser | number | 非必须 | 允许在未找到该浏览器时自动打开默认浏览器,0不允许,1允许 | ||
ssoConfig | object | 必须 | 单点登录配置,需要在特性中心开启后才可配置 | ||
├─ enable | boolean | 必须 | 由于历史原因该参数为必须参数,但本期不建议通过openAPI进行配置,请直接传false |
创建隧道应用
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
accessModel | string | 必须 | 访问模式 | 填写L3VPN即可 | |
subModel | string | 必须 | 子访问模式 | TCP/UDP协议:L3VPN;HTTP(S)协议:TUN2WEB | |
name | string | 必须 | 应用名 | ||
description | string | 非必须 | 描述 | ||
groupId | string | 非必须 | 所属应用分类ID | 可通过应用分类查询接口获取ID | |
groupName | string | 非必须 | 所属应用分类名 | 该参数与groupId至少存在一个。若均存在,以groupId优先 | |
status | number | 必须 | 启用状态 | 0禁用,1启用 | |
iconId | string | 必须 | 预置的图标ID,"1"~"31"可供选择 | 自定义图标设置建议在控制台中配置 | |
nodeGroupId | string | 非必须 | 应用所属节点区域的id | ||
nodeGroupName | string | 非必须 | 应用所属节点区域的名称 | 该参数与nodeGroupId至少存在一个。若均存在,以nodeGroupId优先 | |
allowApply | number | 必须 | 是否允许用户自助申请此应用 | 0不允许,1允许 | |
applyForInfo | object | 必须 | 用户申请信息 | ||
├─ content | string | 必须 | 告警内容 | 例如:"您当前没有该应用的访问权限,请向管理员申请!" | |
├─ accessReason | string[] | 必须 | 申请理由,最少2条,最多5条 | 例如:["我因为岗位职责原因需要访问该应用", "我因为个人特殊原因需要访问该应用"] | |
accessAddress | string | 非必须 | 应用访问入口地址 | ||
addressList | object[] | 必须 | 服务器地址配置 | ||
├─ protocol | string | 必须 | 协议 | tcp/udp/icmp/all | |
├─ host | string | 必须 | 服务器地址,可填ip或域名 | ||
├─ port | string | 必须 | 端口 | ||
trustedCertId | string | 非必须 | 授信证书ID,默认内置web应用证书ID为"default",子访问模式为TUN2WEB时需要填写 | ||
ext | object | 必须 | 扩展字段 | ||
├─ hide | number | 必须 | 是否在用户应用中心隐藏 | 0不隐藏,1隐藏 | |
├─ enableTCPPrefL3 | bool | 非必须 | 是否启用"TCP协议优先使用长隧道连接" | true启用,false 不启用 | |
├─ openModel | object | 非必须 | 打开方式 | ||
├─├─ model | string | 非必须 | no | 方式,有如下几种值:no,default-browser,custom-browser | |
├─├─ programName | string | 非必须 | 程序名称,如果model填写的custom-browser是,则此项需要填写,有如下几种值:Google Chrome(谷歌浏览器)、Internet Explorer(IE浏览器)、360安全浏览器、360极速浏览器、Firefox(火狐浏览器)、Microsoft Edge、QQ浏览器、搜狗浏览器 | ||
├─├─ processName | string | 非必须 | 进程名,如果填写了programName,则需要填写此项,每种浏览器对应的进程名为: Google Chrome(谷歌浏览器):chrome.exe Internet Explorer(IE浏览器):iexplore.exe 360安全浏览器:360se.exe 360极速浏览器:360chrome.exe Firefox(火狐浏览器):firefox.exe Microsoft Edge:msedge.exe QQ浏览器:QQBrowser.exe 搜狗浏览器:SogouExplorer.exe |
||
├─├─ issuerName | array | 非必须 | 签名者名称,如果填写了programName,则需要填写此项,每种浏览器对应的签名者名称为: Google Chrome(谷歌浏览器):Google LLC Internet Explorer(IE浏览器):Microsoft Corporation 360安全浏览器:Beijing Qihu Technology Co., Ltd. 360极速浏览器:Beijing Qihu Technology Co., Ltd. Firefox(火狐浏览器):Mozilla Corporation Microsoft Edge:Microsoft Corporation QQ浏览器:Tencent Technology(Shenzhen) Company Limited 搜狗浏览器:Beijing Sogou Technology Development Co., Ltd. |
||
├─├─ originalFilename | string | 非必须 | 原始文件名,如果填写了programName,则需要填写此项,每种浏览器对应的原始文件名为: Google Chrome(谷歌浏览器):chrome.exe Internet Explorer(IE浏览器):IEXPLORE.EXE 360安全浏览器:360se.exe 360极速浏览器:360chrome.exe Firefox(火狐浏览器):firefox.exe Microsoft Edge:msedge.exe QQ浏览器:QQBrowser.exe 搜狗浏览器:(该浏览器不存在原始文件名) |
||
├─├─ useDefaultBrowser | number | 非必须 | 允许在未找到该浏览器时自动打开默认浏览器,0不允许,1允许 |
请求示例
{
"status": 1,
"accessModel": "L3VPN",
"subModel": "L3VPN",
"name": "[RDP]张三的windows桌面",
"description": "",
"accessAddress": "https://test.com",
"groupId": "default",
"nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
"iconId": "1",
"ext": {
"hide": 0,
"openModel": {
"model": "no",
"originalFilename": "",
"processName": "",
"programDownloadUrl": "",
"programName": "",
"issuerName": [],
"useDefaultBrowser": 0
},
"enableTCPPrefL3": false
},
"addressList": [
{
"protocol": "tcp",
"host": "1.1.1.1",
"port": "3389"
}
],
"applyForInfo": {
"content": "您没有权限访问该应用,如需访问须提交访问申请\n若申请长时间未处理,请联系管理员:\n联系人:张三(工号10001)\n联系电话:1",
"accessReason": [
"我所属组织架构均需要通过此应用开展业务工作",
"我因为岗位职责原因需要访问该应用",
"我因为个人特殊原因需要访问该应用"
]
}
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码 | ||
data | object | 必须 | 数据字段 | ||
├─ id | string | 必须 | 新建应用的ID | ||
msg | string | 必须 | 描述信息 |
错误信息
错误提示 | 错误码 |
---|---|
参数检查出错 | 10000001 |
前端访问地址不能为空 | 10000001 |
隧道应用服务器地址非法 | 10000001 |
授信证书不能为空 | 10000001 |
WEB全网应用特性已启用,当前操作不允许执行,请刷新后重试 | 10000001 |
WEB全网应用特性已启用,当前操作不允许禁用,请刷新后重试 | 10000001 |
当只改写不监听前端地址时,必须有前端地址别名 | 10000001 |
前端访问地址 应用监听端口与预留端口%s冲突,请输入正确的端口号,范围1~65535。\n以下端口除外%s | 77200014 |
数据可能存在异常 | 10000001 |
前端访问地址与客户端接入地址冲突 | 77200018 |
前端访问地址端口与证书认证端口冲突 | 77200018 |
自定义请求头部改写地址必须为后端服务器地址或任一别名地址 | 10000001 |
登录界面地址的协议、主机名及端口需与该应用后端服务器地址保持一致 | 10000001 |
保存失败,应用单点登录配置有误 | 10000001 |
单点登录设置中界面控件名称存在冲突 | 10000001 |
方法入参不能为空 | 10000001 |
当前未配置WEB全网应用,请先配置WEB全网应用 | 10000001 |
当前保存的泛域名与数据库中的记录不匹配,请返回上一级再尝试编辑 | 10000001 |
泛域名应用前端访问地址不允许包含\'.\' | 10000001 |
前端地址别名必须是url格式,如:https://192.168.1.1:443 | 77200010 |
主站点前端地址或别名与依赖站点前端地址或别名冲突 | 10000001 |
应用总数已达上限,无法继续新增 | 77200007 |
单个主站点的依赖站点数量超过最大个数限制 | 10000001 |
该应用的前端访问地址与依赖站点地址存在冲突 | 77200010 |
该应用的后端访问地址与依赖站点地址存在冲突 | 77200010 |
该应用的依赖站点(%s)和应用(%s)的前端地址存在冲突 | 77200010 |
该应用的依赖站点(%s)和其他应用的前端地址存在冲突 | 77200010 |
依赖站点(%s)同时存在当前应用和应用(%s)配置中,为避免冲突建议将此子站点配置为独立应用 | 77200010 |
证书解析失败,强制导入后,将修改为内置web应用证书 | 10000001 |
删除失败 | 10000000 |
WEB全网应用特性已%s,当前操作不允许执行,请刷新后重试 | 10000001 |
证书解析失败,强制导入后,将修改为内置web应用证书 | 10000001 |
此主站点存在多个前端地址相同的依赖站点 | 77200010 |
此主站点存在重复的依赖站点 | 77200010 |
访问地址必须是url格式,如:https://192.168.1.1:443 | 77200010 |
服务器地址必须是url格式,如:https://192.168.1.1:443 | 77200010 |
应用总数已达上限,无法继续新增 | 77200007 |
应用名(%s)已存在 | 77200005 |
应用分类不存在 | 77200001 |
该应用的前端访问地址与应用(%s)的依赖站点存在冲突 | 77200010 |
一个服务器地址只能对应一个访问地址,请先禁用或删除已存在的应用,再匹配新的服务器地址或访问地址 | 77200010 |
节点区域不存在 | 77200001 |
选择的授信证书不存在 | 77200011 |
地址列表超过最大个数限制 | 10000001 |
格式错误,请输入如:192.168.1.1,192.168.1.1/24,192.168.1.1-192.168.1.10,www.xxx.com | 77200010 |
格式错误,请输入如:443,1-65535 | 77200010 |
网络区域不存在 | 10000001 |
创建失败 | 10000000 |
操作失败 | 10000000 |